home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / gemxx19.zoo / gem++19 / man / img.man < prev    next >
Text File  |  1993-05-04  |  3KB  |  103 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      IMG - Standard IMG object format
  7.      ** MONOCHROME IMAGES ONLY **
  8.  
  9. DESCRIPTION
  10.      The "IMG" file format is a standard for GEM bitmaps.  This class
  11.      can read and write such files, and manipulat the bitmap.
  12.  
  13.      IMG manipulations are highly optimized.  Best performance occurs
  14.      if the relative position-change methods are used.
  15.  
  16.      Each IMG has a "current position" which can be used to manipulate
  17.      the bitmap.
  18.  
  19. CONSTRUCTORS
  20.      IMG(int width, int height)
  21.        Create an IMG with the given dimensions.  The contents is left
  22.        uninitialised.
  23.  
  24.      IMG(unsigned char* At, int width, int height)
  25.        Create an IMG with the given dimensions, using the raw image
  26.        data at the given location.  Note that this constructor, in
  27.        combination with the Location(),Width(),Height() members can
  28.        be used to given two views into the same IMG - allowing more
  29.        than one "current position".
  30.  
  31.      IMG(const char *)
  32.        Create an IMG by reading an IMG file.
  33.  
  34. METHODS
  35.      int operator!()
  36.        TRUE iff creation failed (insufficient memory or bad file).
  37.  
  38.      int Save(const char *filename, int PatternLength=2)
  39.        Save the IMG as an IMG file with the given name.  When optimising,
  40.        the given pattern length (default of 2 usually sufficient).
  41.        Note that this method does not do a perfect optimization when
  42.        patterned images are to be saved.
  43.  
  44.      int operator() (int x, int y)
  45.        Move the "current position" to the given coordinate in the bitmap.
  46.  
  47.      void Left()
  48.        Move the "current position" to the left (x--)
  49.  
  50.      void Right()
  51.        Move the "current position" to the right (x++)
  52.  
  53.      void Up()
  54.        Move the "current position" upwards (y--)
  55.  
  56.      void Down()
  57.        Move the "current position" downwards (y++)
  58.  
  59.      void Put(short)
  60.        Set the pixel at the "current position" to the given colour.
  61.  
  62.      short Get()
  63.        Get the colour of the pixel at the "current position".
  64.  
  65.      int Width()
  66.      int Height()
  67.        Return the dimensions of the IMG.
  68.  
  69.      void Repos(long)
  70.      long Pos()
  71.        These methods allow the "current position" to be set and examined.
  72.        DO NOT manipulate the value - consider it ABSTRACT.
  73.  
  74.      void Clear(int colour=0)
  75.        Completely fill the bitmap with the given colour (default blank)
  76.  
  77.      void operator|= (const IMG&)
  78.        Apply a logical OR of another equal-sized bitmap with this one.
  79.  
  80.      unsigned char* Location()
  81.        Returns the location of the bitmap's raw data.
  82.  
  83. SEE ALSO
  84.      GEMimageobject
  85.  
  86. BUGS
  87.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  88.  
  89. AUTHOR
  90.      Warwick Allison, 1993.
  91.      warwick@cs.uq.oz.au
  92.  
  93. COPYING
  94.      This functionality is part of the GEM++ library,
  95.      and is Copyright 1993 by Warwick W. Allison.
  96.  
  97.      GEM++ is free and protected under the GNU Library General Public
  98.      License.
  99.  
  100.      You are free to copy and modify these sources, provided you
  101.      acknowledge the origin by retaining this notice, and adhere to
  102.      the conditions described in the GNU LGPL.
  103.